Your suggested change has been received. Thank you.
Your suggested change has been received. Thank you.
Download OpenAPI specification:Download
The CCC REST API provides Web-based application with a lightweight mean to communicate with the CCC server.
See also:
Get an OpenID Connect bearer token using a password authentication.
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
Authentication data required to get an OpenID Connect bearer token.
| grant_type required | string Default: "password" Value: "password" The only supported value in this REST API version is 'password'. |
| client_id required | string Default: "ccc-cli" Value: "ccc-cli" The only supported value in this REST API version is 'ccc-cli'. |
| username required | string <string> (cccUsername) [ 3 .. 132 ] characters [a-zA-Z0-9][!#$%@\'()*+,\-.\/0-9:=@A-Z\[\]\^_... A CCC admin/application owner username. |
| password required | string <string> (cccUserPassword) [ 8 .. 132 ] characters [a-zA-Z0-9!#$%&()*+,.\/:<=>?@[\]^_{|}~";-]+ A CCC admin/application owner password. |
API docs by Redocly{- "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
- "token_type": "Bearer",
- "expires_in": 1,
- "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}Get the list of devices (authorized and unauthorized).
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
"{\n 'resource':\n [\n {\n 'id': 1\n 'name': 'device-1'\n 'description': 'Device 1'\n 'type': 'application/vnd.safenetinc.lunacloud.v1.adminmonitoringdevice+json'\n 'href': '/api/admin/monitoring/devices/1'\n 'rel': 'monitoring/devices'\n }\n ]\n}\n"Get general information on a service running on a device.
| deviceId required | integer <int32> (deviceId) [ 0 .. 9999 ] A unique CCC device identifier. |
| serviceType required | string (serviceType) Default: "ntls" Enum: "cbs" "lsta" "network" "ntls" "ntp" "syslog" "snmp" "ssh" "stc" "sysstat" "webserver" A type of service. |
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
{- "status": "running"
}Get the list of services.
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
{- "resource": [
- [
- "{\n 'id': 1,\n 'name': 'service-1'\n 'description': 'Service 1'\n 'type': 'application/vnd.safenetinc.lunacloud.v1.adminservice+json'\n 'href': '/api/admin/monitoring/service/1'\n 'rel': 'service'\n}\n"
]
]
}Get the storage spaces allocated to a service.
| serviceId required | integer <int32> (cccServiceId) [ 0 .. 9999 ] Default: 0 A CCC service identifier. |
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
[- "{\n 'free': '78148',\n 'total': '80000',\n 'used': '1852',\n 'label': 'New_Ser',\n 'objectCount': '2',\n 'name': 'New_Ser',\n 'state': 'initialized',\n 'version': '1',\n 'soChangePasswordAttemptsLeft': '10'\n}\n"
]Get the list of devices (authorized and unauthorized) that are enabled for monitoring.
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
"{\n 'resource':\n [\n {\n 'id': 1\n 'name': 'device-1'\n 'description': 'Device 1'\n 'type': 'application/vnd.safenetinc.lunacloud.v1.adminmonitoringdevice+json'\n 'href': '/api/admin/monitoring/devices/1'\n 'rel': 'monitoring/devices'\n }\n ]\n}\n"Get a list of connection statuses for the devices that are enabled for monitoring.
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
[- "{\n 'id': 1,\n 'name': 'device-1'\n 'description': 'Device 1'\n 'type': 'application/vnd.safenetinc.lunacloud.v1.adminmonitoringdevice+json'\n 'href': '/api/admin/monitoring/devices/1'\n 'rel': 'monitoring/devices'\n}\n"
]Get the monitoring attributes of a device that is enabled for monitoring.
| deviceId required | integer <int32> (deviceId) [ 0 .. 9999 ] A unique CCC device identifier. |
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
"{\n 'id': 1\n 'name': 'device-1'\n 'description': 'Device 1'\n 'type': 'application/vnd.safenetinc.lunacloud.v1.adminmonitoringdevice+json'\n 'href': /api/admin/monitoring/devices/1\n 'counters': {\n 'monitoringData': [\n {\n 'type': 'application/vnd.safenetinc.lunacloud.v1.admincounters+json'\n 'href': /api/admin/monitoring/devices/1/counters\n 'rel': 'counters'\n }\n ]\n },\n 'sensors': {\n 'monitoringData': [\n {\n 'type': 'application/vnd.safenetinc.lunacloud.v1.adminsensors+json'\n 'href': /api/admin/monitoring/devices/1/sensors\n 'rel': 'sensors'\n }\n ]\n },\n 'info': {\n 'monitoringData': [\n {\n 'type': 'application/vnd.safenetinc.lunacloud.v1.admininfo+json'\n 'href': /api/admin/monitoring/devices/1/info\n 'rel': 'info'\n }\n ]\n},\n 'performance': {\n 'monitoringData': [\n {\n 'type': 'application/vnd.safenetinc.lunacloud.v1.adminperformance+json'\n 'href': /api/admin/monitoring/devices/1/performance\n 'rel': 'performance'\n }\n ]\n },\n 'nextRunTime': 1726212060007\n 'taskStartTime': 1726212000007\n 'taskEndTime': 1726212046455\n}\n"Get the connection status a device that is enabled for monitoring.
| deviceId required | integer <int32> (deviceId) [ 0 .. 9999 ] A unique CCC device identifier. |
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
"{\n 'id': 1\n 'name': 'device-1'\n 'description': 'Device 1'\n 'type': 'application/vnd.safenetinc.lunacloud.v1.adminmonitoringdevice+json'\n 'href': '/api/admin/monitoring/devices/1'\n 'rel': 'monitoring/devices'\n}\n"Get a list of counters for a device that is enabled for monitoring.
| deviceId required | integer <int32> (deviceId) [ 0 .. 9999 ] A unique CCC device identifier. |
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
{- "lastUpdateTime": 0,
- "data": [
- [
- "{\n 'name': 'commands',\n 'value': '{'total':16871641,'ops_per_second':28.6,'webServerVersion':10}'\n}\n"
]
]
}Get information on a device that is enabled for monitoring.
| deviceId required | integer <int32> (deviceId) [ 0 .. 9999 ] A unique CCC device identifier. |
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
{- "lastUpdateTime": 0,
- "data": [
- [
- "{\n 'name': 'connectionStatus',\n 'value': 'offline'\n}\n"
]
]
}Get a list of performance values for a device that is enabled for monitoring.
| deviceId required | integer <int32> (deviceId) [ 0 .. 9999 ] A unique CCC device identifier. |
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
{- "lastUpdateTime": 0,
- "data": [
- [
- "{\n 'name': 'appliance',\n 'value': '{'uptime':258321.0,'average1MinuteUsage':0.39,'average5MinuteUsage':0.65,'average15MinuteUsage':0.73,'webServerVersion':10}'\n}\n"
]
]
}Get a list of sensors for a device that is enabled for monitoring.
| deviceId required | integer <int32> (deviceId) [ 0 .. 9999 ] A unique CCC device identifier. |
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
{- "lastUpdateTime": 0,
- "data": [
- [
- "{\n 'name': 'CPU',\n 'value': '{'id':'CPU','lowerCritical':null,'lowerNonCritical':null,'lowerNonRecoverable':null,'type':'Temperature','unit':'degrees C','upperCritical':'95','upperNonCritical':null,'upperNonRecoverable':'100','value':'22','variance':'0','lowerBound':'0','upperBound':'120','displayName':'CPU Temp','webServerVersion':'13'}'\n}\n"
]
]
}Get the average operation per seconds for a service as a map.
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
"{\n '1': '0',\n '2': '0',\n '3': '0',\n '4': '0',\n '103': '1',\n '104': '0',\n '5': '------',\n '6': '------',\n '51': '------'\n}\n"Get client monitoring information for a service.
| serviceId required | integer <int32> (cccServiceId) [ 0 .. 9999 ] Default: 0 A CCC service identifier. |
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
[- "{\n 'connectionType': 'NTLS',\n 'deviceAddress': '192.168.168.100',\n 'clientAddress': '192.168.168.200',\n 'state': 'CLOSED',\n 'protocol': '----',\n 'connectedPartition': 'partition-1'\n}\n"
]Get PUM (Performance Utilization Metrics) for a service and a partition as a doughnut.
| serviceId required | integer <int32> (cccServiceId) [ 0 .. 9999 ] Default: 0 A CCC service identifier. |
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
"{\n 'DECRYPT': '0',\n 'ALL_OPERATIONS': '4',\n 'KEY_DERIVATION': '0',\n 'PUM_POLICY_STATUS': 'true',\n 'KEY_GENERATION': '4',\n 'VERIFY': '0',\n 'ENCRYPT': '0',\n 'SIGN': '0'\n}\n"Get PUM (Performance Utilization Metrics) for a service and a partition as a line chart.
| serviceId required | integer <int32> (cccServiceId) [ 0 .. 9999 ] Default: 0 A CCC service identifier. |
| elemId | integer <int32> (cccServiceId) [ 0 .. 9999 ] Default: 0 A CCC service identifier. |
| operationId | string Default: "All_Operations" Value: "All_Operations" |
| per | string Default: "SECONDS" Value: "SECOND" |
| startTime | integer <int64> (timestamp) >= 0 A timestamp in Epoch. |
| endTime | integer <int64> (timestamp) >= 0 A timestamp in Epoch. |
| timeLabel | string Default: "lastHour" Value: "lastHour" |
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
"[\n {\n 'idServElement': 0,\n 'lastUpdateTime': 1726891199857,\n 'data': \n [\n {\n 'name': 'Operations/Sec',\n 'value': '0'\n }\n {\n 'name': 'Avg Operations/Sec',\n 'value': '0'\n },\n {\n 'name': 'operationId',\n 'value': 'ALL_OPERATIONS'\n }\n ]\n }\n]\n"Get PUM (Performance Utilization Metrics) policy status for a service element.
| serviceId required | integer <int32> (cccServiceId) [ 0 .. 9999 ] Default: 0 A CCC service identifier. |
| serviceElementId required | integer <int32> (serviceElementId) [ 0 .. 9999 ] Default: 0 A CCC service element identifier. |
| Content-Type required | string Example: application/vnd.safenetinc.lunacloud.v1+json |
{- "LAST_METRICS_RECORD_TIMESTAMP": 0,
- "PUM_POLICY_STATUS": true,
- "METRICS_COUNTER_RESET_TIME": 0
}